<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>bn::regular_bg_builder class | Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacebn.html">bn</a>::<wbr/></span>regular_bg_builder <span class="m-thin">class</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__regular__bg__builder_8h.html">&lt;bn_regular_bg_builder.h&gt;</a></div>
        </h1>
        <p>Creates <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> objects with custom attributes.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>If some of the attributes of the regular background to create differs from the default ones, using this class improves performance.</p>
        <section id="typeless-methods">
          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#a8e0a1ddbabba73e91ca75336be141e5b" class="m-doc">regular_bg_builder</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item) <span class="m-label m-flat m-info">explicit</span> </span>
            </dt>
            <dd>Constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#a4ce52e0ee24d9553fc6e7a4fd672934d" class="m-doc">regular_bg_builder</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item,
              int map_index)</span>
            </dt>
            <dd>Constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#a93cbe1f5d7a9f7045f8abaf443b100b1" class="m-doc">regular_bg_builder</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; map) <span class="m-label m-flat m-info">explicit</span> </span>
            </dt>
            <dd>Constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#a11d1b9cf6f9763f562982c5dee83f6b2" class="m-doc">regular_bg_builder</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp;&amp; map) <span class="m-label m-flat m-info">explicit</span> </span>
            </dt>
            <dd>Constructor.</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt id="a8d8f02aae6ed6cad31e9c9c7f68a86fe">
              <span class="m-doc-wrap-bumper">auto <a href="#a8d8f02aae6ed6cad31e9c9c7f68a86fe" class="m-doc-self">item</a>(</span><span class="m-doc-wrap">) const -&gt; const <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&gt;&amp;</span>
            </dt>
            <dd>Returns the <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a> containing the required information to generate regular backgrounds if it has one; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</dd>
            <dt id="a03385aa39737188b1f2cb138496be182">
              <span class="m-doc-wrap-bumper">auto <a href="#a03385aa39737188b1f2cb138496be182" class="m-doc-self">map_index</a>(</span><span class="m-doc-wrap">) const -&gt; int</span>
            </dt>
            <dd>Index of the map to reference in item.map_item() to generate regular backgrounds.</dd>
            <dt id="a4f1432024e4d04abad5717d54c7cdbf6">
              <span class="m-doc-wrap-bumper">auto <a href="#a4f1432024e4d04abad5717d54c7cdbf6" class="m-doc-self">x</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the horizontal position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a50eaea4531eea7ed518ec046b58287ab" class="m-doc">set_x</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> x) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the horizontal position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt id="a62999d064526a091cb5251961156ea16">
              <span class="m-doc-wrap-bumper">auto <a href="#a62999d064526a091cb5251961156ea16" class="m-doc-self">y</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the vertical position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a45235726dc88f8ec1b148f3058ce60fb" class="m-doc">set_y</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> y) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the vertical position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt id="aa5e421bc2f34cbd4920bb38272c9e665">
              <span class="m-doc-wrap-bumper">auto <a href="#aa5e421bc2f34cbd4920bb38272c9e665" class="m-doc-self">position</a>(</span><span class="m-doc-wrap">) const -&gt; const <a href="namespacebn.html#a9d90d92eb951850d75801f5508fc8e90" class="m-doc">fixed_<wbr />point</a>&amp;</span>
            </dt>
            <dd>Returns the position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a29be7bd8f2d60e7025410122a0b28ee0" class="m-doc">set_position</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> x,
              <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> y) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a06f6c25ff1a2425616b4d07f01ba97aa" class="m-doc">set_position</a>(</span><span class="m-doc-wrap">const <a href="namespacebn.html#a9d90d92eb951850d75801f5508fc8e90" class="m-doc">fixed_<wbr />point</a>&amp; position) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt id="a8c8e3adab5a7b73b02eb9a0bb4219db3">
              <span class="m-doc-wrap-bumper">auto <a href="#a8c8e3adab5a7b73b02eb9a0bb4219db3" class="m-doc-self">top_left_x</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the horizontal top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a27959008691f7c318f1d3f935e2dc4ab" class="m-doc">set_top_left_x</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> top_left_x) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the horizontal top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt id="af0e38f04de2dd688fbb627d66fdd6515">
              <span class="m-doc-wrap-bumper">auto <a href="#af0e38f04de2dd688fbb627d66fdd6515" class="m-doc-self">top_left_y</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a></span>
            </dt>
            <dd>Returns the vertical top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#addeef30e6b421a1ff65e9919c44de2a9" class="m-doc">set_top_left_y</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> top_left_y) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the vertical top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt id="a12ea4b4ead9a143ebd5b90cc83a97b12">
              <span class="m-doc-wrap-bumper">auto <a href="#a12ea4b4ead9a143ebd5b90cc83a97b12" class="m-doc-self">top_left_position</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="namespacebn.html#a9d90d92eb951850d75801f5508fc8e90" class="m-doc">fixed_<wbr />point</a></span>
            </dt>
            <dd>Returns the top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a8dbdb51938812eae66a4c3b5766ae3d0" class="m-doc">set_top_left_position</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> top_left_x,
              <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> top_left_y) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a7a34b8dfa6ba4d5a6f50e09938ed35d7" class="m-doc">set_top_left_position</a>(</span><span class="m-doc-wrap">const <a href="namespacebn.html#a9d90d92eb951850d75801f5508fc8e90" class="m-doc">fixed_<wbr />point</a>&amp; top_left_position) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#aabe344de59821139331388b889c78e86" class="m-doc">priority</a>(</span><span class="m-doc-wrap">) const -&gt; int</span>
            </dt>
            <dd>Returns the priority of the regular backgrounds to generate relative to sprites and other backgrounds.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#ae64d3c630131a49961dd75ed0327ed3a" class="m-doc">set_priority</a>(</span><span class="m-doc-wrap">int priority) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the priority of the regular backgrounds to generate relative to sprites and other backgrounds.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#afa4233e9dc54a94c60a43744b90895c0" class="m-doc">z_order</a>(</span><span class="m-doc-wrap">) const -&gt; int</span>
            </dt>
            <dd>Returns the priority of the regular backgrounds to generate relative to other backgrounds, excluding sprites.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#aa4954d04825fc655298eeec3129befdb" class="m-doc">set_z_order</a>(</span><span class="m-doc-wrap">int z_order) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the priority of the regular backgrounds to generate relative to other backgrounds, excluding sprites.</dd>
            <dt id="a065fa96ca2b2b6d8a7e1ffb0b07ca7ca">
              <span class="m-doc-wrap-bumper">auto <a href="#a065fa96ca2b2b6d8a7e1ffb0b07ca7ca" class="m-doc-self">mosaic_enabled</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if the mosaic effect must be applied to the regular backgrounds to generate or not.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a2dd792e2204adfcc70c78e592db550d1" class="m-doc">set_mosaic_enabled</a>(</span><span class="m-doc-wrap">bool mosaic_enabled) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets if the mosaic effect must be applied to the regular backgrounds to generate or not.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a50eb9ed9db95d9dc525d19131c6d07df" class="m-doc">blending_enabled</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if blending must be applied to the regular backgrounds to generate or not.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#ae835dee332c2c615c269a8657ff5cd63" class="m-doc">set_blending_enabled</a>(</span><span class="m-doc-wrap">bool blending_enabled) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets if blending must be applied to the regular backgrounds to generate or not.</dd>
            <dt id="aaef76dd3e842d3307382ae6f0b390c7d">
              <span class="m-doc-wrap-bumper">auto <a href="#aaef76dd3e842d3307382ae6f0b390c7d" class="m-doc-self">blending_top_enabled</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if the regular backgrounds to generate must be part of the blending top layer or not.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#aa2a2c9ef6cb935542515ceffcacbf618" class="m-doc">set_blending_top_enabled</a>(</span><span class="m-doc-wrap">bool blending_top_enabled) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets if the regular backgrounds to generate must be part of the blending top layer or not.</dd>
            <dt id="aeb20bcce9aaf7a984687ca98cc55b2f5">
              <span class="m-doc-wrap-bumper">auto <a href="#aeb20bcce9aaf7a984687ca98cc55b2f5" class="m-doc-self">blending_bottom_enabled</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if the regular backgrounds to generate must be part of the blending bottom layer or not.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a0b0e9b8dbf0c9ef60cafcb2ef3f3e560" class="m-doc">set_blending_bottom_enabled</a>(</span><span class="m-doc-wrap">bool blending_bottom_enabled) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets if the regular backgrounds to generate must be part of the blending bottom layer or not.</dd>
            <dt id="a32057ad65f3581702769df140f77f3f7">
              <span class="m-doc-wrap-bumper">auto <a href="#a32057ad65f3581702769df140f77f3f7" class="m-doc-self">green_swap_mode</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="group__green__swap.html#ga6ed8f658483577341079c6a880231745" class="m-doc">bn::<wbr />green_swap_mode</a></span>
            </dt>
            <dd>Indicates how the regular backgrounds to generate must be displayed when green swap is enabled.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#af47c4b2cc4600712d0e4f69251c49cc6" class="m-doc">set_green_swap_mode</a>(</span><span class="m-doc-wrap"><a href="group__green__swap.html#ga6ed8f658483577341079c6a880231745" class="m-doc">bn::<wbr />green_swap_mode</a> green_swap_mode) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets how the regular backgrounds to generate must be displayed when green swap is enabled.</dd>
            <dt id="a716db23735ce6ffb46cf40ced7dbcdf6">
              <span class="m-doc-wrap-bumper">auto <a href="#a716db23735ce6ffb46cf40ced7dbcdf6" class="m-doc-self">visible</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if the regular backgrounds to generate must be committed to the GBA or not.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a3db92bbf3d061cb8824758eaf08737ef" class="m-doc">set_visible</a>(</span><span class="m-doc-wrap">bool visible) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets if the regular backgrounds to generate must be committed to the GBA or not.</dd>
            <dt id="ae10c6b9f0a763237ee573c5752f973d8">
              <span class="m-doc-wrap-bumper">auto <a href="#ae10c6b9f0a763237ee573c5752f973d8" class="m-doc-self">camera</a>(</span><span class="m-doc-wrap">) const -&gt; const <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&gt;&amp;</span>
            </dt>
            <dd>Returns the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate (if any).</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#ae91d26e67fc6c9118f46647c73e47e21" class="m-doc">set_camera</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&amp; camera) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#aa80c7e0cc7d43d5c359e356aac99e63f" class="m-doc">set_camera</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&amp;&amp; camera) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a66dfd413d699c897294985eb00301823" class="m-doc">set_camera</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&gt;&amp; camera) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets or removes the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a0bc34fc54bed0fecee7460c67fe80c5a" class="m-doc">set_camera</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&gt;&amp;&amp; camera) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Sets or removes the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#add97f86f8a93ada3eec3a314e0300ee5" class="m-doc">remove_camera</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp;</span>
            </dt>
            <dd>Removes the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</dd>
            <dt id="a327aef3ecbaf95d9dbb22460792ae628">
              <span class="m-doc-wrap-bumper">auto <a href="#a327aef3ecbaf95d9dbb22460792ae628" class="m-doc-self">release_camera</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Releases and returns the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate (if any).</dd>
            <dt id="a4e0f5434c0e53cced945a63eb4c6d417">
              <span class="m-doc-wrap-bumper">auto <a href="#a4e0f5434c0e53cced945a63eb4c6d417" class="m-doc-self">build</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a></span>
            </dt>
            <dd>Generates and returns a <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> without releasing the acquired resources.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a3c4f9f0537f892c61300c29a75d2a015" class="m-doc">release_build</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a></span>
            </dt>
            <dd>Generates and returns a <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> releasing the acquired resources.</dd>
            <dt id="adb91f883ff69ca4fb0e1909bc62e3381">
              <span class="m-doc-wrap-bumper">auto <a href="#adb91f883ff69ca4fb0e1909bc62e3381" class="m-doc-self">build_optional</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Generates and returns a <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> without releasing the acquired resources if it could be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a60c2973d1f7428998e696657f31cb2bb" class="m-doc">release_build_optional</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Generates and returns a <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> releasing the acquired resources if it could be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</dd>
            <dt id="a94d843b2ab45b46da14476e6d510be4a">
              <span class="m-doc-wrap-bumper">auto <a href="#a94d843b2ab45b46da14476e6d510be4a" class="m-doc-self">map</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a></span>
            </dt>
            <dd>Generates and returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> without releasing the acquired resources.</dd>
            <dt id="ab652efee52bd89e62ead10edc5b20ece">
              <span class="m-doc-wrap-bumper">auto <a href="#ab652efee52bd89e62ead10edc5b20ece" class="m-doc-self">map_optional</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Generates and returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> without releasing the acquired resources if it could be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#abe19cf1c064c64ff457fe0ac131d9346" class="m-doc">release_map</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a></span>
            </dt>
            <dd>Generates and returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> releasing the acquired resources.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a9b17644307c2c94bcd4461d7f67d6701" class="m-doc">release_map_optional</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Generates and returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> releasing the acquired resources if it could be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="a8e0a1ddbabba73e91ca75336be141e5b"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8e0a1ddbabba73e91ca75336be141e5b" class="m-doc-self">regular_bg_builder</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item) <span class="m-label m-info">explicit</span> </span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">item</td>
                  <td><a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a> containing the required information to generate regular backgrounds.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a4ce52e0ee24d9553fc6e7a4fd672934d"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a4ce52e0ee24d9553fc6e7a4fd672934d" class="m-doc-self">regular_bg_builder</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item,
              int map_index)</span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">item</td>
                  <td><a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a> containing the required information to generate regular backgrounds.</td>
                </tr>
                <tr>
                  <td>map_index</td>
                  <td>Index of the map to reference in item.map_item() to generate regular backgrounds.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a93cbe1f5d7a9f7045f8abaf443b100b1"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a93cbe1f5d7a9f7045f8abaf443b100b1" class="m-doc-self">regular_bg_builder</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; map) <span class="m-label m-info">explicit</span> </span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map</td>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to copy for generating regular backgrounds.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a11d1b9cf6f9763f562982c5dee83f6b2"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a11d1b9cf6f9763f562982c5dee83f6b2" class="m-doc-self">regular_bg_builder</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp;&amp; map) <span class="m-label m-info">explicit</span> </span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map</td>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to move for generating regular backgrounds.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a50eaea4531eea7ed518ec046b58287ab"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a50eaea4531eea7ed518ec046b58287ab" class="m-doc-self">set_x</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> x)</span></span>
            </h3>
            <p>Sets the horizontal position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">x</td>
                  <td>Horizontal position of the regular backgrounds to generate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a45235726dc88f8ec1b148f3058ce60fb"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a45235726dc88f8ec1b148f3058ce60fb" class="m-doc-self">set_y</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> y)</span></span>
            </h3>
            <p>Sets the vertical position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">y</td>
                  <td>vertical position of the regular backgrounds to generate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a29be7bd8f2d60e7025410122a0b28ee0"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a29be7bd8f2d60e7025410122a0b28ee0" class="m-doc-self">set_position</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> x,
              <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> y)</span></span>
            </h3>
            <p>Sets the position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">x</td>
                  <td>Horizontal position of the regular backgrounds to generate.</td>
                </tr>
                <tr>
                  <td>y</td>
                  <td>Vertical position of the regular backgrounds to generate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a06f6c25ff1a2425616b4d07f01ba97aa"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a06f6c25ff1a2425616b4d07f01ba97aa" class="m-doc-self">set_position</a>(</span><span class="m-doc-wrap">const <a href="namespacebn.html#a9d90d92eb951850d75801f5508fc8e90" class="m-doc">fixed_<wbr />point</a>&amp; position)</span></span>
            </h3>
            <p>Sets the position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">position</td>
                  <td>Position of the regular backgrounds to generate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a27959008691f7c318f1d3f935e2dc4ab"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a27959008691f7c318f1d3f935e2dc4ab" class="m-doc-self">set_top_left_x</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> top_left_x)</span></span>
            </h3>
            <p>Sets the horizontal top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">top_left_x</td>
                  <td>Horizontal top-left position of the regular backgrounds to generate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="addeef30e6b421a1ff65e9919c44de2a9"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#addeef30e6b421a1ff65e9919c44de2a9" class="m-doc-self">set_top_left_y</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> top_left_y)</span></span>
            </h3>
            <p>Sets the vertical top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">top_left_y</td>
                  <td>Vertical top-left position of the regular backgrounds to generate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a8dbdb51938812eae66a4c3b5766ae3d0"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8dbdb51938812eae66a4c3b5766ae3d0" class="m-doc-self">set_top_left_position</a>(</span><span class="m-doc-wrap"><a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> top_left_x,
              <a href="namespacebn.html#a0de0484a51e353c5b48db21590f4dfc9" class="m-doc">fixed</a> top_left_y)</span></span>
            </h3>
            <p>Sets the top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">top_left_x</td>
                  <td>Horizontal top-left position of the regular backgrounds to generate.</td>
                </tr>
                <tr>
                  <td>top_left_y</td>
                  <td>Vertical top-left position of the regular backgrounds to generate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a7a34b8dfa6ba4d5a6f50e09938ed35d7"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a7a34b8dfa6ba4d5a6f50e09938ed35d7" class="m-doc-self">set_top_left_position</a>(</span><span class="m-doc-wrap">const <a href="namespacebn.html#a9d90d92eb951850d75801f5508fc8e90" class="m-doc">fixed_<wbr />point</a>&amp; top_left_position)</span></span>
            </h3>
            <p>Sets the top-left position of the regular backgrounds to generate (relative to their camera, if they are going to have one).</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">top_left_position</td>
                  <td>Top-left position of the regular backgrounds to generate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="aabe344de59821139331388b889c78e86"><div>
            <h3>
              <span class="m-doc-wrap-bumper">int bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aabe344de59821139331388b889c78e86" class="m-doc-self">priority</a>(</span><span class="m-doc-wrap">) const</span></span>
            </h3>
            <p>Returns the priority of the regular backgrounds to generate relative to sprites and other backgrounds.</p>
<p>Backgrounds with higher priority are drawn first (and therefore can be covered by later sprites and backgrounds).</p>
          </div></section>
          <section class="m-doc-details" id="ae64d3c630131a49961dd75ed0327ed3a"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae64d3c630131a49961dd75ed0327ed3a" class="m-doc-self">set_priority</a>(</span><span class="m-doc-wrap">int priority)</span></span>
            </h3>
            <p>Sets the priority of the regular backgrounds to generate relative to sprites and other backgrounds.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">priority</td>
                  <td>Priority in the range [0..3].</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
<p>Backgrounds with higher priority are drawn first (and therefore can be covered by later sprites and backgrounds).</p>
          </div></section>
          <section class="m-doc-details" id="afa4233e9dc54a94c60a43744b90895c0"><div>
            <h3>
              <span class="m-doc-wrap-bumper">int bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#afa4233e9dc54a94c60a43744b90895c0" class="m-doc-self">z_order</a>(</span><span class="m-doc-wrap">) const</span></span>
            </h3>
            <p>Returns the priority of the regular backgrounds to generate relative to other backgrounds, excluding sprites.</p>
<p>Backgrounds with higher z orders are drawn first (and therefore can be covered by later backgrounds).</p><p>Due to hardware limitations, affine backgrounds can be drawn before regular backgrounds with higher z order.</p>
          </div></section>
          <section class="m-doc-details" id="aa4954d04825fc655298eeec3129befdb"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa4954d04825fc655298eeec3129befdb" class="m-doc-self">set_z_order</a>(</span><span class="m-doc-wrap">int z_order)</span></span>
            </h3>
            <p>Sets the priority of the regular backgrounds to generate relative to other backgrounds, excluding sprites.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">z_order</td>
                  <td>Priority relative to other backgrounds, excluding sprites, in the range [-32767..32767].</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
<p>Backgrounds with higher z orders are drawn first (and therefore can be covered by later backgrounds).</p><p>Due to hardware limitations, affine backgrounds can be drawn before regular backgrounds with higher z order.</p>
          </div></section>
          <section class="m-doc-details" id="a2dd792e2204adfcc70c78e592db550d1"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a2dd792e2204adfcc70c78e592db550d1" class="m-doc-self">set_mosaic_enabled</a>(</span><span class="m-doc-wrap">bool mosaic_enabled)</span></span>
            </h3>
            <p>Sets if the mosaic effect must be applied to the regular backgrounds to generate or not.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">mosaic_enabled</td>
                  <td><code>true</code> if the mosaic effect must be applied; <code>false</code> otherwise.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a50eb9ed9db95d9dc525d19131c6d07df"><div>
            <h3>
              <span class="m-doc-wrap-bumper">bool bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a50eb9ed9db95d9dc525d19131c6d07df" class="m-doc-self">blending_enabled</a>(</span><span class="m-doc-wrap">) const</span></span>
            </h3>
            <p>Indicates if blending must be applied to the regular backgrounds to generate or not.</p>
<p>Blending is applied to regular backgrounds by making them part of the blending top layer.</p>
          </div></section>
          <section class="m-doc-details" id="ae835dee332c2c615c269a8657ff5cd63"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae835dee332c2c615c269a8657ff5cd63" class="m-doc-self">set_blending_enabled</a>(</span><span class="m-doc-wrap">bool blending_enabled)</span></span>
            </h3>
            <p>Sets if blending must be applied to the regular backgrounds to generate or not.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">blending_enabled</td>
                  <td><code>true</code> if blending must be applied; <code>false</code> otherwise.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
<p>Blending is applied to regular backgrounds by making them part of the blending top layer.</p>
          </div></section>
          <section class="m-doc-details" id="aa2a2c9ef6cb935542515ceffcacbf618"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa2a2c9ef6cb935542515ceffcacbf618" class="m-doc-self">set_blending_top_enabled</a>(</span><span class="m-doc-wrap">bool blending_top_enabled)</span></span>
            </h3>
            <p>Sets if the regular backgrounds to generate must be part of the blending top layer or not.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">blending_top_enabled</td>
                  <td><code>true</code> if generated backgrounds must be part of the blending top layer; <code>false</code> otherwise.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a0b0e9b8dbf0c9ef60cafcb2ef3f3e560"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0b0e9b8dbf0c9ef60cafcb2ef3f3e560" class="m-doc-self">set_blending_bottom_enabled</a>(</span><span class="m-doc-wrap">bool blending_bottom_enabled)</span></span>
            </h3>
            <p>Sets if the regular backgrounds to generate must be part of the blending bottom layer or not.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">blending_bottom_enabled</td>
                  <td><code>true</code> if generated backgrounds must be part of the blending bottom layer; <code>false</code> otherwise.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="af47c4b2cc4600712d0e4f69251c49cc6"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af47c4b2cc4600712d0e4f69251c49cc6" class="m-doc-self">set_green_swap_mode</a>(</span><span class="m-doc-wrap"><a href="group__green__swap.html#ga6ed8f658483577341079c6a880231745" class="m-doc">bn::<wbr />green_swap_mode</a> green_swap_mode)</span></span>
            </h3>
            <p>Sets how the regular backgrounds to generate must be displayed when green swap is enabled.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">green_swap_mode</td>
                  <td>Green swap mode.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a3db92bbf3d061cb8824758eaf08737ef"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a3db92bbf3d061cb8824758eaf08737ef" class="m-doc-self">set_visible</a>(</span><span class="m-doc-wrap">bool visible)</span></span>
            </h3>
            <p>Sets if the regular backgrounds to generate must be committed to the GBA or not.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">visible</td>
                  <td><code>true</code> if the regular backgrounds must be committed to the GBA; <code>false</code> otherwise.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="ae91d26e67fc6c9118f46647c73e47e21"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae91d26e67fc6c9118f46647c73e47e21" class="m-doc-self">set_camera</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&amp; camera)</span></span>
            </h3>
            <p>Sets the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">camera</td>
                  <td><a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to copy to the builder.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="aa80c7e0cc7d43d5c359e356aac99e63f"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa80c7e0cc7d43d5c359e356aac99e63f" class="m-doc-self">set_camera</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&amp;&amp; camera)</span></span>
            </h3>
            <p>Sets the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">camera</td>
                  <td><a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to move to the builder.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a66dfd413d699c897294985eb00301823"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a66dfd413d699c897294985eb00301823" class="m-doc-self">set_camera</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&gt;&amp; camera)</span></span>
            </h3>
            <p>Sets or removes the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">camera</td>
                  <td>Optional <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to copy to the builder.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a0bc34fc54bed0fecee7460c67fe80c5a"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0bc34fc54bed0fecee7460c67fe80c5a" class="m-doc-self">set_camera</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a>&gt;&amp;&amp; camera)</span></span>
            </h3>
            <p>Sets or removes the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">camera</td>
                  <td>Optional <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to move to the builder.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="add97f86f8a93ada3eec3a314e0300ee5"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__builder.html" class="m-doc">regular_<wbr />bg_<wbr />builder</a>&amp; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#add97f86f8a93ada3eec3a314e0300ee5" class="m-doc-self">remove_camera</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>Removes the <a href="classbn_1_1camera__ptr.html" class="m-doc">camera_<wbr />ptr</a> to attach to the regular backgrounds to generate.</p>
            <table class="m-table m-fullwidth m-flat">
              <tfoot>
                <tr>
                  <th style="width: 1%">Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a3c4f9f0537f892c61300c29a75d2a015"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a3c4f9f0537f892c61300c29a75d2a015" class="m-doc-self">release_build</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>Generates and returns a <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> releasing the acquired resources.</p>
<p><a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> generation after calling this method may stop working.</p>
          </div></section>
          <section class="m-doc-details" id="a60c2973d1f7428998e696657f31cb2bb"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a60c2973d1f7428998e696657f31cb2bb" class="m-doc-self">release_build_optional</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>Generates and returns a <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> releasing the acquired resources if it could be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</p>
<p><a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> generation after calling this method may stop working.</p>
          </div></section>
          <section class="m-doc-details" id="abe19cf1c064c64ff457fe0ac131d9346"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#abe19cf1c064c64ff457fe0ac131d9346" class="m-doc-self">release_map</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>Generates and returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> releasing the acquired resources.</p>
<p><a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> generation after calling this method may stop working.</p>
          </div></section>
          <section class="m-doc-details" id="a9b17644307c2c94bcd4461d7f67d6701"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_builder::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a9b17644307c2c94bcd4461d7f67d6701" class="m-doc-self">release_map_optional</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>Generates and returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> releasing the acquired resources if it could be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</p>
<p><a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a> generation after calling this method may stop working.</p>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
